<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfcRequest</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.0">
<link rel="home" href="index.html" title="libinfinity-0.4 Reference Manual">
<link rel="up" href="ch04.html" title="Libinfinity client side API">
<link rel="prev" href="InfcUserRequest.html" title="InfcUserRequest">
<link rel="next" href="InfcRequestManager.html" title="InfcRequestManager">
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="InfcUserRequest.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch04.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libinfinity-0.4 Reference Manual</th>
<td><a accesskey="n" href="InfcRequestManager.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#InfcRequest.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#InfcRequest.description" class="shortcut">Description</a>
                   | 
                  <a href="#InfcRequest.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#InfcRequest.properties" class="shortcut">Properties</a>
                   | 
                  <a href="#InfcRequest.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry" title="InfcRequest">
<a name="InfcRequest"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfcRequest.top_of_page"></a>InfcRequest</span></h2>
<p>InfcRequest — Requests sent to server</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="InfcRequest.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="InfcRequest.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libinfinity/client/infc-request.h&gt;

                    <a class="link" href="InfcRequest.html#InfcRequest-struct" title="InfcRequest">InfcRequest</a>;
                    <a class="link" href="InfcRequest.html#InfcRequestClass" title="InfcRequestClass">InfcRequestClass</a>;
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="InfcRequest.html#infc-request-get-seq" title="infc_request_get_seq ()">infc_request_get_seq</a>                (<em class="parameter"><code><a class="link" href="InfcRequest.html" title="InfcRequest"><span class="type">InfcRequest</span></a> *request</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="InfcRequest.html#infc-request-get-name" title="infc_request_get_name ()">infc_request_get_name</a>               (<em class="parameter"><code><a class="link" href="InfcRequest.html" title="InfcRequest"><span class="type">InfcRequest</span></a> *request</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="InfcRequest.html#infc-request-failed" title="infc_request_failed ()">infc_request_failed</a>                 (<em class="parameter"><code><a class="link" href="InfcRequest.html" title="InfcRequest"><span class="type">InfcRequest</span></a> *request</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="InfcRequest.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----InfcRequest
         +----<a class="link" href="InfcExploreRequest.html" title="InfcExploreRequest">InfcExploreRequest</a>
         +----<a class="link" href="InfcNodeRequest.html" title="InfcNodeRequest">InfcNodeRequest</a>
         +----<a class="link" href="InfcUserRequest.html" title="InfcUserRequest">InfcUserRequest</a>
</pre>
</div>
<div class="refsect1" title="Properties">
<a name="InfcRequest.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="InfcRequest.html#InfcRequest--name" title='The "name" property'>name</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
  "<a class="link" href="InfcRequest.html#InfcRequest--seq" title='The "seq" property'>seq</a>"                      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1" title="Signals">
<a name="InfcRequest.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="InfcRequest.html#InfcRequest-failed" title='The "failed" signal'>failed</a>"                                         : Run Last
</pre>
</div>
<div class="refsect1" title="Description">
<a name="InfcRequest.description"></a><h2>Description</h2>
<p>
A <a class="link" href="InfcRequest.html" title="InfcRequest"><span class="type">InfcRequest</span></a> represents a request that was sent to the server. It can
be used to get information related to that request and to be notified
when the request fails or finishes.
</p>
<p>
<a class="link" href="InfcRequest.html" title="InfcRequest"><span class="type">InfcRequest</span></a> is the base class for other requests and only has the
<a class="link" href="InfcRequest.html#InfcRequest-failed" title='The "failed" signal'><span class="type">"failed"</span></a> signal. Use signals from specific requests such as
<a class="link" href="InfcNodeRequest.html" title="InfcNodeRequest"><span class="type">InfcNodeRequest</span></a> to get further notification. Every request has a name
and a sequence number. The sequence number is used in the server reply to
refer to a specific request and normally of no use for developers using
the infinote API.
</p>
</div>
<div class="refsect1" title="Details">
<a name="InfcRequest.details"></a><h2>Details</h2>
<div class="refsect2" title="InfcRequest">
<a name="InfcRequest-struct"></a><h3>InfcRequest</h3>
<pre class="programlisting">typedef struct _InfcRequest InfcRequest;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="InfcRequestClass">
<a name="InfcRequestClass"></a><h3>InfcRequestClass</h3>
<pre class="programlisting">typedef struct {
  GObjectClass parent_class;

  /* Signals */
  void (*failed)(InfcRequest* request, GError* error);

  void (*unused1)(void);
  void (*usused2)(void);
} InfcRequestClass;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="infc_request_get_seq ()">
<a name="infc-request-get-seq"></a><h3>infc_request_get_seq ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               infc_request_get_seq                (<em class="parameter"><code><a class="link" href="InfcRequest.html" title="InfcRequest"><span class="type">InfcRequest</span></a> *request</code></em>);</pre>
<p>
Returns the sequence identifier for this request.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>request</code></em> :</span></p></td>
<td>A <a class="link" href="InfcRequest.html" title="InfcRequest"><span class="type">InfcRequest</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The sequence number for <span class="type">request</span>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infc_request_get_name ()">
<a name="infc-request-get-name"></a><h3>infc_request_get_name ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       infc_request_get_name               (<em class="parameter"><code><a class="link" href="InfcRequest.html" title="InfcRequest"><span class="type">InfcRequest</span></a> *request</code></em>);</pre>
<p>
Returns the name of the request.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>request</code></em> :</span></p></td>
<td>A <a class="link" href="InfcRequest.html" title="InfcRequest"><span class="type">InfcRequest</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The name of <em class="parameter"><code>request</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infc_request_failed ()">
<a name="infc-request-failed"></a><h3>infc_request_failed ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                infc_request_failed                 (<em class="parameter"><code><a class="link" href="InfcRequest.html" title="InfcRequest"><span class="type">InfcRequest</span></a> *request</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>);</pre>
<p>
Emits the "failed" signal on <em class="parameter"><code>request</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>request</code></em> :</span></p></td>
<td>A <a class="link" href="InfcRequest.html" title="InfcRequest"><span class="type">InfcRequest</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="InfcRequest.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "name" property'>
<a name="InfcRequest--name"></a><h3>The <code class="literal">"name"</code> property</h3>
<pre class="programlisting">  "name"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
<p>Name of the request.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" title='The "seq" property'>
<a name="InfcRequest--seq"></a><h3>The <code class="literal">"seq"</code> property</h3>
<pre class="programlisting">  "seq"                      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct Only</pre>
<p>Identifier for this request.</p>
<p>Default value: 0</p>
</div>
</div>
<div class="refsect1" title="Signal Details">
<a name="InfcRequest.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" title='The "failed" signal'>
<a name="InfcRequest-failed"></a><h3>The <code class="literal">"failed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="InfcRequest.html" title="InfcRequest"><span class="type">InfcRequest</span></a> *request,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>     error,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>     user_data)      : Run Last</pre>
<p>
Emitted when the request could not be processed on the server side.
<em class="parameter"><code>error</code></em> holds additional information on why the request failed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>request</code></em> :</span></p></td>
<td>The failed <a class="link" href="InfcRequest.html" title="InfcRequest"><span class="type">InfcRequest</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A pointer to a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> object with details on the error.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="See Also">
<a name="InfcRequest.see-also"></a><h2>See Also</h2>
<a class="link" href="InfcUserRequest.html" title="InfcUserRequest"><span class="type">InfcUserRequest</span></a>, <a class="link" href="InfcNodeRequest.html" title="InfcNodeRequest"><span class="type">InfcNodeRequest</span></a>, <a class="link" href="InfcExploreRequest.html" title="InfcExploreRequest"><span class="type">InfcExploreRequest</span></a>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.15</div>
</body>
</html>